Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 4.18 KB

CONTRIBUTING.md

File metadata and controls

74 lines (51 loc) · 4.18 KB
Raw

Contributing to aragon.js

🎉 Thank you for being interested in contributing to an Aragon Project! 🎉

Feel welcome and read the following sections in order to know how to ask questions and how to work on something.

All members of our community are expected to follow our Code of Conduct. Please make sure you are welcoming and friendly in all of our spaces.

Ways to contribute

File an issue

If you see a problem that should be improved, you can simply report it in our issue tracker. Please take a quick look to see if the issue doesn't already exist before filing yours.

Do your best to include as many details as needed in order for someone else to fix the problem and resolve the issue.

Fix an issue

You can browse our issue tracker and choose an issue to fix. The development process follows one typical of open source contributions. Here's a quick rundown:

  1. Find an issue that you are interested in addressing or a feature that you would like to add.
  2. Fork the repository to your local GitHub organization. This means that you will have a copy of the repository under your-GitHub-username/hack.
  3. Clone the repository to your local machine using git clone https://github.com/github-username/aragon.js.git.
  4. Create a new branch for your fix using git checkout -b branch-name-here.
  5. Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
  6. Use git add insert-paths-of-changed-files-here to add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index.
  7. Use git commit -m "Insert a short message of the changes made here" to store the contents of the index with a descriptive message.
  8. Push the changes to the remote repository using git push origin branch-name-here.
  9. Submit a pull request in github to the upstream repository.
  10. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can use a title like "Added more log outputting to resolve #4352".
  11. In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is). The reviewer will be able to help you fix any problems and improve it!
  12. Wait for the pull request to be reviewed by a maintainer.
  13. Make changes to the pull request if the maintainer recommends them.
  14. Celebrate your success after your pull request is merged!

Your First Code Contribution

Unsure where to begin contributing? You can start by looking through these good first issue issues:

  • Good first issue - issues which should only require a few lines of code, and a test or two.

Getting help

If you need help, please reach out to Aragon core contributors and community members on Discord. We'd love to hear from you and know what you're working on!

Styleguides

Commits

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

A good rule of thumb is that your commit message follows these rules if you can prefix it with "This commit will ..." and it makes sense.

For example, "This commit will add a feature" vs "This commit will added a feature".

JavaScript

All JavaScript must adhere to JavaScript Standard Style.

  • Prefer the object spread operator ({...anotherObj}) to Object.assign()
  • Inline exports with expressions whenever possible
  js
  // Use this:
  export default class ClassName {

  }

  // Instead of:
  class ClassName {

  }
  export default ClassName