Skip to content

Commit

Permalink
Added a small amount of text for people looking to get started but ar…
Browse files Browse the repository at this point in the history
…e not aware of gitflow (#3707)

* Added a small amount of text for people looking to get started who might not be used to the Gitflow process

* Updated the readme to include a little more information for people that are not full time developers

* Fix reStructuredText formatting

There needs to be an empty line between the heading and the next paragraph. Otherwise, the markup isn’t rendered correctly.

---------

Co-authored-by: Till Prochaska <[email protected]>
  • Loading branch information
Rosencrantz and tillprochaska authored May 16, 2024
1 parent eb740f3 commit f660281
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ If, after reviewing the list (or selecting an issue to work on) you'd like to re

### Forking and Branching

All new development work needs to happen on a branch. If this is your first time, you'll not have the ability to create branches directly from Aleph so will need to fork the repo. Once you've done this create an issue branch and commit all you changes to this. Make sure you set up [commit signing](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) beforehand.
The Aleph team uses the Gitflow method of branching and merging. If you are not familiar with Gitflow then you can [read all about it here](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow). All new development work needs to happen on a branch. If this is your first time, you'll not have the ability to create branches directly from Aleph so will need to fork the repo. Once you've done this create an issue branch and commit all you changes to this. Make sure you set up [commit signing](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) beforehand.

### Pull Requests

Expand All @@ -54,7 +54,7 @@ Aleph uses two main branches. The **develop** branch is for any new work that ne

### Code Formatting and Linting

We use automatic code formatters and linters to keep our code consistent and to spot bugs and style issues early in the process. For Python code, we use [black](https://black.readthedocs.io/en/stable/) and [ruff](https://beta.ruff.rs/). Our JavaScript code base uses [Prettier](https://prettier.io) and [ESLint](https://eslint.org/).
We use automatic code formatters and linters to keep our code consistent and to spot bugs and style issues early in the process. For Python code, we use [black](https://black.readthedocs.io/en/stable/) and [ruff](https://beta.ruff.rs/). Our JavaScript code base uses [Prettier](https://prettier.io) and [ESLint](https://eslint.org/).

When you open a pull request, your changes are automatically checked for consistency with our code formatting and linting rules. You can also run the checks in your local development environment. If you aren’t familiar with these tools yet, don’t worry. You can open a pull request even if your changes don’t pass these checks.

Expand Down
8 changes: 8 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,14 @@ in touch:

* https://docs.aleph.occrp.org/get-in-touch

Aleph Development
-----------------

If you're looking to get involved with the development of Aleph, please check the `CONTRIBUTING.md` file for details on how to get started.

⚠️ **IMPORTANT** ⚠️
The default branch in this GitHub repository is "develop". The develop branch contains unreleased, unstable code. For stable releases, please check out the `list of releases <https://github.com/alephdata/aleph/releases>`_ or switch to the `main branch <https://github.com/alephdata/aleph/tree/main>`_.

Release process
---------------

Expand Down

0 comments on commit f660281

Please sign in to comment.